home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / perl5 / Mail / Send.pod < prev    next >
Encoding:
Text File  |  2008-04-14  |  2.8 KB  |  140 lines
  1. =head1 NAME
  2.  
  3. Mail::Send - Simple electronic mail interface
  4.  
  5. =head1 INHERITANCE
  6.  
  7. =head1 SYNOPSIS
  8.  
  9.   require Mail::Send;
  10.  
  11.   $msg = Mail::Send->new;
  12.   $msg = Mail::Send->new(Subject => 'example', To => 'timbo');
  13.  
  14.   $msg->to('user@host');
  15.   $msg->to('user@host', 'user2@example.com');
  16.   $msg->subject('example subject');
  17.   $msg->cc('user@host');
  18.   $msg->bcc('someone@else');
  19.  
  20.   $msg->set($header, @values);
  21.   $msg->add($header, @values);
  22.   $msg->delete($header);
  23.  
  24.   # Launch mailer and set headers. The filehandle returned
  25.   # by open() is an instance of the Mail::Mailer class.
  26.   # Arguments to the open() method are passed to the Mail::Mailer
  27.   # constructor.
  28.  
  29.   $fh = $msg->open;   # some default mailer
  30.   $fh = $msg->open('sendmail'); # explicit
  31.   print $fh "Body of message";
  32.   $fh->close;         # complete the message and send it
  33.  
  34. =head1 DESCRIPTION
  35.  
  36. L<Mail::Send|Mail::Send> creates e-mail messages without using the L<Mail::Header|Mail::Header>
  37. knowledge, which means that all escaping and folding must be done by
  38. you!  Simplicity has its price.
  39.  
  40. When you have time, take a look at Mail::Transport
  41.  
  42. =head1 METHODS
  43.  
  44. =head2 Constructors
  45.  
  46. Mail::Send-E<gt>B<new>(PAIRS)
  47.  
  48. =over 4
  49.  
  50. A list of header fields (provided as key-value PAIRS) can be
  51. used to initialize the object.
  52.  
  53. =back
  54.  
  55. =head2 Header fields
  56.  
  57. $obj-E<gt>B<add>(FIELDNAME, VALUES)
  58.  
  59. =over 4
  60.  
  61. Add values to the list of defined values for the FIELDNAME.
  62.  
  63. =back
  64.  
  65. $obj-E<gt>B<bcc>(VALUES)
  66.  
  67. =over 4
  68.  
  69. =back
  70.  
  71. $obj-E<gt>B<cc>(VALUES)
  72.  
  73. =over 4
  74.  
  75. =back
  76.  
  77. $obj-E<gt>B<delete>(FIELDNAME)
  78.  
  79. =over 4
  80.  
  81. =back
  82.  
  83. $obj-E<gt>B<set>(FIELDNAME, VALUES)
  84.  
  85. =over 4
  86.  
  87. VALUES will replace the old values for the FIELDNAME.  Returned is
  88. the LIST of values after modification.
  89.  
  90. =back
  91.  
  92. $obj-E<gt>B<subject>(VALUES)
  93.  
  94. =over 4
  95.  
  96. =back
  97.  
  98. $obj-E<gt>B<to>(VALUES)
  99.  
  100. =over 4
  101.  
  102. =back
  103.  
  104. =head2 Sending
  105.  
  106. $obj-E<gt>B<open>(OPTIONS)
  107.  
  108. =over 4
  109.  
  110. The OPTIONS are used to initiate a mailer object via
  111. L<Mail::Mailer::new()|Mail::Mailer/"Constructors">.  Then L<Mail::Mailer::open()|Mail::Mailer/"Constructors"> is called
  112. with the knowledge collected in this Mail::Send object.
  113.  
  114. =back
  115.  
  116. =head1 SEE ALSO
  117.  
  118. This module is part of the MailTools distribution,
  119. F<http://perl.overmeer.net/mailtools/>.
  120.  
  121. =head1 AUTHORS
  122.  
  123. The MailTools bundle was developed by Graham Barr.  Later, Mark
  124. Overmeer took over maintenance without development.
  125.  
  126. Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
  127. Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
  128. Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
  129. For other contributors see ChangeLog.
  130.  
  131. =head1 LICENSE
  132.  
  133. Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
  134. 2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
  135.  
  136. This program is free software; you can redistribute it and/or modify it
  137. under the same terms as Perl itself.
  138. See F<http://www.perl.com/perl/misc/Artistic.html>
  139.  
  140.